home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / gamest11.zip / GAMESTAT.DOC < prev    next >
Text File  |  1991-10-18  |  9KB  |  221 lines
  1. ╔══════════╗  ╓───╖                ╓──╖
  2. ║ ╔══╗     ║  ║     ╓──╖ ╓─╥─╖ ╓── ║    ─╥─ ╓──╖ ─╥─         ╥    ╥  ╓──╖
  3. ║ ║  ║ ╥   ║  ║ ╓─╖ ╟──╢ ║ ╨ ║ ╟─  ╙──╖  ║  ╟──╢  ║          ║    ║  ║  ║
  4. ║ ╠═╦╝ ║   ║  ║   ║ ║  ║ ║   ║ ║      ║  ║  ║  ║  ║    ╥  ╥  ║    ║  ║  ║
  5. ║ ║ ╚╗ ║   ║  ║   ║ ║  ║ ║   ║ ║      ║  ║  ║  ║  ║    ╙╖╓╜  ║    ║  ║  ║
  6. ║ ╨  ╨ ╚══ ║  ╙───╜ ╨  ╨ ╨   ╨ ╙── ╙──╜  ╨  ╨  ╨  ╨     ╙╜   ╨  ° ╨  ╙──╜
  7. ╚══════════╝                 <c> 1991 RoyaLink Software
  8.                           Written by Greg King (1:206/2503)
  9.  
  10.  
  11. DISCLAIMER :   This program has been tested to work.  But, things happen so
  12.                RoyaLink Software and Greg King can not be held liable for
  13.                any effects that this software may have on your system.  The
  14.                only gaurentee that is provided is that this software WILL
  15.                occupy disk space.  USE THIS PROGRAM AT YOUR OWN RISK!
  16.  
  17. REGISTRATION : This version is provided completly free.  My reasons for coding
  18.                this was to experiment with arrays, and to thank the door
  19.                authors for their hard work.  I had the easy part and do not
  20.                feel compelled to charge for something like this.  Subsequent
  21.                versions may have a different policy.  If you feel compelled
  22.                to do something, send me a net-mail message so I know how you
  23.                like it.
  24.  
  25. ABOUT THIS   : This software was written using POWER BASIC from Robert S. Zale.
  26. PROGRAM        It is intended to be run as part of your nightly event, so
  27.                memory restrictions should not be of concern.
  28.  
  29. ------------------------------------------------------------------------------
  30. Files Included
  31. in the archive :     Gamestat.doc  (this document)
  32.                      Gamestat.exe  (The executable)
  33.                      Gamestat.cfg  (Sample configuration file)
  34.  
  35. If there are files missing or added, please let me know via netmail at
  36. 1:206/2503.  Also tell me where you obtained the program from.
  37.  
  38.  
  39. SETTING UP...
  40.               First, edit the configuration file to your liking.
  41. I provided a sample file for you to edit and included instructions and
  42. usage documentation in it.  For future reference, leave the instructions in
  43. the file as I will not go into them in this document.
  44.  
  45. Next, modify your door batch files to include a line that says
  46.  
  47.       ECHO <doorname> >><input>
  48.  
  49. where doorname is the name of the door (limit 20 characters) and input is
  50. the file you specified in GAMESTAT.CFG's INPUT option.  The two greater
  51. than signs are VERY important as they cause the  text to be appended and
  52. not overwritten.  I know this is a lot of work, but it only has to be done
  53. once!
  54.  
  55. When a user selects the door, your batch file will now add a line to the
  56. input file that has the name of the door.
  57.  
  58. Here is an example using Land of Devestation...
  59.  
  60. c:
  61. cd\d\lod
  62. copy c:\p\info.bbs
  63. xcon ph ra c:\u\xcon.cfg c:\d\lod
  64. echo Land Of Devestation >>c:\games.dat       <---------- this line!
  65. game 1
  66. cd\p
  67.  
  68. RUNNING Gamestat...  In your nighlty event, cause your batch file to go
  69. to the same directory as Gamestat.EXE and Gamestat.cfg (they must be in the
  70. same directory unless you use the /c option described later).
  71.  
  72. Execute Gamestat.exe and then DELETE your input file (as specified in
  73. Gamestat.CFG).  This is important because I do not delete it in the program.
  74.  
  75. WHAT DOES IT DO?  Gamestat reads in the games that are played and adds them
  76. to a random file.  Upon execution, it first adds one day to the existing
  77. records.  It then updates the games that have been played, adding any new
  78. ones.  It then divides the number of times played by the days the game has
  79. been availible.  Then it sorts the records by the average plays per day,
  80. creates a graphical representation of usage and outputs the top 15 to the
  81. file you specified in the config file.
  82.  
  83. Gamestat will now produce a colorized output as well.  If you desire a
  84. color output, then use the ansibull option in the config file.  If you
  85. do not want this option, comment that line out!  The color options in the
  86. config file will be ignored if you do not specify a color output.
  87.  
  88. .....................
  89. Command Line Switches
  90. .....................
  91.  
  92. EDIT
  93.  
  94.      If you wish to purge some of the records for what ever reason, run
  95.      Gamestat with a command line parameter of EDIT (no slashes or anything,
  96.      just edit.  That will pull up and editor that I threw together.  It
  97.      should be pretty simple to figure out.
  98.  
  99.      Note, using the editor function, you can only delete a record.  No
  100.      other changes are allowed.
  101.  
  102.      If you are running seperate data files, this will only edit GAMESTAT.DAT
  103.      in the current directory, so rename files as necessary.
  104.  
  105.  
  106. /C <drive:\path\filename>
  107.  
  108.      This option allows you to specify a different configuration file
  109.      than the default (gamestat.cfg).  Combined with the datafile statement
  110.      in the configuration file, this feature allows creativity in the ways
  111.      you may run the program.  Seperate reports per node are possible as is
  112.      an updated report after every call.
  113.  
  114. RESTARTING...
  115.  
  116.      If you want to restart the program, delete Gamestat.dat (or other names
  117.      you may have specified in the datafile statement) and it will restart the
  118.      next time you run it.
  119.  
  120. SAMPLE EXECUTION:
  121.  
  122.       Say you want an output after every call that only shows that days
  123.       games...
  124.  
  125.       Copy over your config file over to a new name (I will use Today.cfg for
  126.       this explanation).
  127.  
  128.       Change the datafile to something like today.dat, change the bulletin
  129.       names as appropriate.  Change your bbs name to "TODAY's" and comment out 
  130.       the nodenomber entry.
  131.  
  132.       Execute ...
  133.  
  134.         Gamestat /cToday.cfg
  135.  
  136.       The program will run and only consider the games that have been played
  137.       so far today.  Delete your today.dat or else wierd results will occur
  138.       after the next caller logs off!
  139.  
  140.       Note that the title of the bulletin say
  141.  
  142.                  TODAY's On Line Game Summary
  143.  
  144.  
  145. This is just one other execution example.  Expierement and see what you can
  146. come up with.  If you would net-mail me back with some examples, I may
  147. include them in the next distribution package with credit going to you.
  148.  
  149.  
  150. SUPPORT:  Should you experience any bugs or errors while running this
  151.           program, you can reach me via netmail at 1:206/2503 or call
  152.           my bbs at (805) 488-7430 (2400-9600 HST).  I am also a regular
  153.           reader of the DOORWARE echo.  Please be as descriptive as
  154.           possible and include the information contained in GAMESTAT.ERR
  155.           which is generated whenever an error is encountered.
  156.  
  157.  
  158. ----------------------------------------
  159. - Thanks to the following Beta Testers -
  160. ----------------------------------------
  161. Johnie Robinson (1:383/3396)
  162. Bill Bailey (1:124/1701)
  163. Paul Bailey (1:396/24)
  164. Jim Kiersey (1:105/64)
  165. Linda Thompson (1:275/50)
  166.  
  167.  
  168. ------------
  169. - History: -
  170. ------------
  171. 1.00  (9/22/91)
  172.       Initial release
  173.  
  174.  
  175.  
  176. 1.10 (10/20/91)
  177.  
  178.     Corrected some oversights in the ANSI bulletin.
  179.  
  180.     Editor showed incorrect number of files when you selected one for
  181.     deletion.  This is fixed, as is the "empty Data File" bug when
  182.     you purge the file.
  183.  
  184.     If you entitled a game with more than 20 characters, the program would
  185.     consider every playing a new game and add it to the data file.  Game
  186.     titles more than 20 characters are now processed with the first 20
  187.     characters only.
  188.  
  189.     A small "bug" in the configuration file was detected.  If  you declared
  190.     an option but did not supply an arguement to it, the program would
  191.     bomb with an error 5 providing no information as to why it wouldnt work.
  192.     This was corrected by adding some error checking that ended up shortening
  193.     the code by almost 10%!  It will now abort with an error 199 and tell you
  194.     the offending line number.
  195.  
  196.     Added an extra line in the bulletin that shows the average plays per
  197.     day of all game